Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add a FAQ #1977

Merged
merged 1 commit into from
Aug 8, 2023
Merged

Docs: Add a FAQ #1977

merged 1 commit into from
Aug 8, 2023

Conversation

PhilipMetzger
Copy link
Contributor

@PhilipMetzger PhilipMetzger commented Aug 4, 2023

This answers some questions, which were repeatedly asked in Discord.

Rendered

Checklist

If applicable:

  • I have updated CHANGELOG.md
  • I have updated the documentation (README.md, docs/, demos/)
  • I have updated the config schema (src/config-schema.json)
  • I have added tests to cover my changes

README.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ilyagr ilyagr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much for collecting these questions, it's a great list!

I worry that many of your answers would be unclear for somebody not quite on your wavelength, so I edited many of the questions and answers. A lot of my comments might sound quite critical. I hope you won't mind; I do think that what you wrote is a great start.

Alternatively, we can use what you wrote as a nice outline for what we should say; I can edit the text in a separate PR if you prefer.

docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
@PhilipMetzger PhilipMetzger force-pushed the push-wmvntxtmkkmm branch 2 times, most recently from 4c2426c to 93df93d Compare August 5, 2023 15:12
docs/FAQ.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ilyagr ilyagr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much for the edits, this looks much better!

I edited one more question and I'm still waffling about what to do with one of the other questions. Other than that, this is looking good to me.

docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ilyagr ilyagr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this helps a lot!

docs/FAQ.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ilyagr ilyagr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thank you very much for doing this!

This answers some questions, which were repeatedly asked in Discord.
@PhilipMetzger PhilipMetzger enabled auto-merge (rebase) August 8, 2023 23:08
@PhilipMetzger PhilipMetzger merged commit 8188dc4 into main Aug 8, 2023
@PhilipMetzger PhilipMetzger deleted the push-wmvntxtmkkmm branch August 8, 2023 23:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants